Skip to main content
PATCH
/
allocations
Update an allocation
curl --request PATCH \
  --url https://your_a2_service/allocations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ext": {},
  "last_comment": "",
  "no": 123,
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z"
}'
{
  "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ext": {},
  "last_comment": "",
  "no": 123,
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for updating allocation entity.

​
no
integer
required

The number of the allocation

​
owner_id
string<uuid>
required

The id of the user who created this allocation

​
status
enum<string>
required

Represents the status of an allocation between a campaign and placement.

Available options:
pending,
requested,
published,
rejected,
canceled,
finished
​
tagid
string<uuid>
required

The id of the placement where the campaign will be allocated

​
cid
string<uuid> | null

The id of the campaign to be allocated to the placement

​
created_at
string<date-time> | null

The date and time the entity was created.

​
crid
string<uuid> | null
deprecated
​
ext
object
​
last_comment
string
default:""

Most recent comment added by retailer during the allocation approval process

​
updated_at
string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Schema for reading allocation entity.

​
no
integer
required

The number of the allocation

​
owner_id
string<uuid>
required

The id of the user who created this allocation

​
status
string
required

The current status of the allocation (e.g. draft, published, rejected)

​
tagid
string<uuid>
required

The id of the placement where the campaign will be allocated

​
cid
string<uuid> | null

The id of the campaign to be allocated to the placement

​
created_at
string<date-time> | null

The date and time the entity was created.

​
crid
string<uuid> | null
deprecated
​
ext
object
​
last_comment
string
default:""

Most recent comment added by retailer during the allocation approval process

​
updated_at
string<date-time> | null

The date and time the entity was last updated.